Add BaseCodec to the docs #2290
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dstansby
added
documentation
d-v-b
reviewed
Oct 5, 2024
src/zarr/abc/codec.py
Outdated
| @@ -34,11 +35,15 @@ | |||
| CodecOutput = TypeVar("CodecOutput", bound=NDBuffer | Buffer) | |||
|
|
|||
|
|
|||
| class _Codec(Metadata, Generic[CodecInput, CodecOutput]): | |||
| class CodecBase(Metadata, Generic[CodecInput, CodecOutput]): | |||
There was a problem hiding this comment.
Feel free to ignore this suggestion, but somehow the name BaseCodec seems a bit more natural than CodecBase. Maybe it seems a bit more consistent with names like RemoteStore which follow the <Qualification><QualifiedEntity> schema?
There was a problem hiding this comment.
👍 I think that's a good suggestion, changed
dstansby
force-pushed
the
doc-codecbase
branch
from
3080102
to
8149ca3
Compare
d-v-b
approved these changes
Oct 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This renames
_CodectoCodecBase, so that it gets documented and linked from e.g.ArrayArrayCodec, which is currently missing a link to it.I think in general it's nicer to document the full class heirarchy, but put warnings where we don't expect users to use specific classes. This fixes some broken links, a small part of #2291